home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 4 / Apprentice-Release4.iso / Languages / MPW Oberon 2.1168 / OInterfaces / Collections.mod < prev    next >
Encoding:
Text File  |  1995-08-10  |  12.8 KB  |  328 lines  |  [TEXT/MPS ]
  1. (*
  2.      File:        Collections.mod
  3.  
  4.      Contains:    Collection Manager Interfaces.
  5.  
  6.      Version:    Technology:    Quickdraw GX 1.0
  7.                  Package:    Universal Interfaces 2.1ß1 in “MPW Prerelease” on ETO #17
  8.  
  9.      Copyright:    © 1984-1995 by Apple Computer, Inc.
  10.                  All rights reserved.
  11.  
  12.      Bugs?:        If you find a problem with this file, use the Apple Bug Reporter
  13.                  stack.  Include the file and version information (from above)
  14.                  in the problem description and send to:
  15.                      Internet:    apple.bugs.applelink.apple.com
  16.                      AppleLink:    APPLE.BUGS
  17.  
  18. *)
  19.  
  20. (*$TAGS-*)
  21. (*$CALLING PASCAL*)
  22. MODULE Collections;
  23.  
  24. IMPORT SYSTEM, Types;
  25.  
  26. (* $PUSH*)
  27. (* $ALIGN MAC68K*)
  28. (* $LibExport+*)
  29.  
  30. CONST
  31.     gestaltCollectionMgrVersion*    = LONG("cltn");
  32.  
  33. (* Collection Manager Error Result Codes... *)
  34.     collectionItemLockedErr*        = -5750;
  35.     collectionItemNotFoundErr*    = -5751;
  36.     collectionIndexRangeErr*        = -5752;
  37.     collectionVersionErr*        = -5753;
  38.  
  39. (* Convenience constants for functions which optionally return values... *)
  40.     dontWantTag*                    = 0;
  41.     dontWantId*                    = 0;
  42.     dontWantSize*                = 0;
  43.     dontWantAttributes*            = 0;
  44.     dontWantIndex*                = 0;
  45.     dontWantData*                = 0;
  46.  
  47. (* attributes bits *)
  48.     noCollectionAttributes*        = $00000000;                    (* no attributes bits set *)
  49.     allCollectionAttributes*        = $FFFFFFFF;                    (* all attributes bits set *)
  50.     userCollectionAttributes*    = $0000FFFF;                    (* user attributes bits *)
  51.     defaultCollectionAttributes*    = $40000000;                    (* default attributes - unlocked, persistent *)
  52.  
  53. (* 
  54.     Attribute bits 0 through 15 (entire low word) are reserved for use by the application.
  55.     Attribute bits 16 through 31 (entire high word) are reserved for use by the Collection Manager.
  56.     Only bits 31 (collectionLockBit) and 30 (collectionPersistenceBit) currently have meaning.
  57. *)
  58.     collectionUser0Bit*            = 0;
  59.     collectionUser1Bit*            = 1;
  60.     collectionUser2Bit*            = 2;
  61.     collectionUser3Bit*            = 3;
  62.     collectionUser4Bit*            = 4;
  63.     collectionUser5Bit*            = 5;
  64.     collectionUser6Bit*            = 6;
  65.     collectionUser7Bit*            = 7;
  66.     collectionUser8Bit*            = 8;
  67.     collectionUser9Bit*            = 9;
  68.     collectionUser10Bit*            = 10;
  69.     collectionUser11Bit*            = 11;
  70.     collectionUser12Bit*            = 12;
  71.     collectionUser13Bit*            = 13;
  72.     collectionUser14Bit*            = 14;
  73.     collectionUser15Bit*            = 15;
  74.     collectionReserved0Bit*        = 16;
  75.     collectionReserved1Bit*        = 17;
  76.     collectionReserved2Bit*        = 18;
  77.     collectionReserved3Bit*        = 19;
  78.     collectionReserved4Bit*        = 20;
  79.     collectionReserved5Bit*        = 21;
  80.     collectionReserved6Bit*        = 22;
  81.     collectionReserved7Bit*        = 23;
  82.     collectionReserved8Bit*        = 24;
  83.     collectionReserved9Bit*        = 25;
  84.     collectionReserved10Bit*        = 26;
  85.     collectionReserved11Bit*        = 27;
  86.     collectionReserved12Bit*        = 28;
  87.     collectionReserved13Bit*        = 29;
  88.     collectionPersistenceBit*    = 30;
  89.     collectionLockBit*            = 31;
  90.  
  91. (* attribute masks *)
  92.     collectionUser0Mask*            = ASH(1,collectionUser0Bit);
  93.     collectionUser1Mask*            = ASH(1,collectionUser1Bit);
  94.     collectionUser2Mask*            = ASH(1,collectionUser2Bit);
  95.     collectionUser3Mask*            = ASH(1,collectionUser3Bit);
  96.     collectionUser4Mask*            = ASH(1,collectionUser4Bit);
  97.     collectionUser5Mask*            = ASH(1,collectionUser5Bit);
  98.     collectionUser6Mask*            = ASH(1,collectionUser6Bit);
  99.     collectionUser7Mask*            = ASH(1,collectionUser7Bit);
  100.     collectionUser8Mask*            = ASH(1,collectionUser8Bit);
  101.     collectionUser9Mask*            = ASH(1,collectionUser9Bit);
  102.     collectionUser10Mask*        = ASH(1,collectionUser10Bit);
  103.     collectionUser11Mask*        = ASH(1,collectionUser11Bit);
  104.     collectionUser12Mask*        = ASH(1,collectionUser12Bit);
  105.     collectionUser13Mask*        = ASH(1,collectionUser13Bit);
  106.     collectionUser14Mask*        = ASH(1,collectionUser14Bit);
  107.     collectionUser15Mask*        = ASH(1,collectionUser15Bit);
  108.     collectionReserved0Mask*        = ASH(1,collectionReserved0Bit);
  109.     collectionReserved1Mask*        = ASH(1,collectionReserved1Bit);
  110.     collectionReserved2Mask*        = ASH(1,collectionReserved2Bit);
  111.     collectionReserved3Mask*        = ASH(1,collectionReserved3Bit);
  112.     collectionReserved4Mask*        = ASH(1,collectionReserved4Bit);
  113.     collectionReserved5Mask*        = ASH(1,collectionReserved5Bit);
  114.     collectionReserved6Mask*        = ASH(1,collectionReserved6Bit);
  115.     collectionReserved7Mask*        = ASH(1,collectionReserved7Bit);
  116.     collectionReserved8Mask*        = ASH(1,collectionReserved8Bit);
  117.     collectionReserved9Mask*        = ASH(1,collectionReserved9Bit);
  118.     collectionReserved10Mask*    = ASH(1,collectionReserved10Bit);
  119.     collectionReserved11Mask*    = ASH(1,collectionReserved11Bit);
  120.     collectionReserved12Mask*    = ASH(1,collectionReserved12Bit);
  121.     collectionReserved13Mask*    = ASH(1,collectionReserved13Bit);
  122.     collectionPersistenceMask*    = ASH(1,collectionPersistenceBit);
  123.     collectionLockMask*            = ASH(1,collectionLockBit);
  124.  
  125. (***********)
  126. (* Types   *)
  127. (***********)
  128. (* abstract data type for a collection *)
  129.     
  130. TYPE
  131.     Collection* = Types.Ptr;
  132.  
  133.     CollectionTag* = Types.FourCharCode;
  134.  
  135.     CollectionFlattenProcPtr* = (*ΔΔ Types.ProcPtr;*) PROCEDURE (size: LONGINT; data: (*ΔΔUNIVΔΔ*) Types.Ptr; refCon: (*ΔΔUNIVΔΔ*) Types.Ptr): Types.OSErr;
  136.     CollectionExceptionProcPtr* = (*ΔΔ Types.ProcPtr;*) PROCEDURE (c: Collection; status: Types.OSErr): Types.OSErr;
  137.     CollectionFlattenUPP* = Types.UniversalProcPtr;
  138.     CollectionExceptionUPP* = Types.UniversalProcPtr;
  139.  
  140. CONST
  141.     uppCollectionFlattenProcInfo* = $00000FE0; (* PROCEDURE (4 byte param, 4 byte param, 4 byte param): 2 byte result; *)
  142.     uppCollectionExceptionProcInfo* = $000002E0; (* PROCEDURE (4 byte param, 2 byte param): 2 byte result; *)
  143.  
  144. PROCEDURE NewCollectionFlattenProc*(userRoutine: CollectionFlattenProcPtr): CollectionFlattenUPP;
  145.     (*$IF NOT GENERATINGCFM *)
  146.     INLINE PASCAL $2E9F;
  147.     (*$END*)
  148.  
  149. PROCEDURE NewCollectionExceptionProc*(userRoutine: CollectionExceptionProcPtr): CollectionExceptionUPP;
  150.     (*$IF NOT GENERATINGCFM *)
  151.     INLINE PASCAL $2E9F;
  152.     (*$END*)
  153.  
  154. PROCEDURE CallCollectionFlattenProc*(size: LONGINT; data: (*ΔΔUNIVΔΔ*) Types.Ptr; refCon: (*ΔΔUNIVΔΔ*) Types.Ptr; userRoutine: CollectionFlattenUPP): Types.OSErr;
  155.     (*$IF NOT GENERATINGCFM*)
  156.     INLINE PASCAL $205F, $4E90;
  157.     (*$END*)
  158.  
  159. PROCEDURE CallCollectionExceptionProc*(c: Collection; status: Types.OSErr; userRoutine: CollectionExceptionUPP): Types.OSErr;
  160.     (*$IF NOT GENERATINGCFM*)
  161.     INLINE PASCAL $205F, $4E90;
  162.     (*$END*)
  163.  
  164. PROCEDURE NewCollection*(): Collection;
  165.     (*$IF NOT GENERATINGCFM*)
  166.     INLINE PASCAL $7000, $ABF6;
  167.     (*$END*)
  168. PROCEDURE DisposeCollection*(c: Collection);
  169.     (*$IF NOT GENERATINGCFM*)
  170.     INLINE PASCAL $7001, $ABF6;
  171.     (*$END*)
  172. PROCEDURE CloneCollection*(c: Collection): Collection;
  173.     (*$IF NOT GENERATINGCFM*)
  174.     INLINE PASCAL $7002, $ABF6;
  175.     (*$END*)
  176. PROCEDURE CountCollectionOwners*(c: Collection): LONGINT;
  177.     (*$IF NOT GENERATINGCFM*)
  178.     INLINE PASCAL $7003, $ABF6;
  179.     (*$END*)
  180. PROCEDURE CopyCollection*(srcCollection: Collection; dstCollection: Collection): Collection;
  181.     (*$IF NOT GENERATINGCFM*)
  182.     INLINE PASCAL $7004, $ABF6;
  183.     (*$END*)
  184. PROCEDURE GetCollectionDefaultAttributes*(c: Collection): LONGINT;
  185.     (*$IF NOT GENERATINGCFM*)
  186.     INLINE PASCAL $7005, $ABF6;
  187.     (*$END*)
  188. PROCEDURE SetCollectionDefaultAttributes*(c: Collection; whichAttributes: LONGINT; newAttributes: LONGINT);
  189.     (*$IF NOT GENERATINGCFM*)
  190.     INLINE PASCAL $7006, $ABF6;
  191.     (*$END*)
  192. PROCEDURE CountCollectionItems*(c: Collection): LONGINT;
  193.     (*$IF NOT GENERATINGCFM*)
  194.     INLINE PASCAL $7007, $ABF6;
  195.     (*$END*)
  196. PROCEDURE AddCollectionItem*(c: Collection; tag: CollectionTag; id: LONGINT; itemSize: LONGINT; itemData: (*ΔΔUNIVΔΔ*) Types.Ptr): Types.OSErr;
  197.     (*$IF NOT GENERATINGCFM*)
  198.     INLINE PASCAL $7008, $ABF6;
  199.     (*$END*)
  200. PROCEDURE GetCollectionItem*(c: Collection; tag: CollectionTag; id: LONGINT; VAR itemSize: LONGINT; itemData: (*ΔΔUNIVΔΔ*) Types.Ptr): Types.OSErr;
  201.     (*$IF NOT GENERATINGCFM*)
  202.     INLINE PASCAL $7009, $ABF6;
  203.     (*$END*)
  204. PROCEDURE RemoveCollectionItem*(c: Collection; tag: CollectionTag; id: LONGINT): Types.OSErr;
  205.     (*$IF NOT GENERATINGCFM*)
  206.     INLINE PASCAL $700A, $ABF6;
  207.     (*$END*)
  208. PROCEDURE SetCollectionItemInfo*(c: Collection; tag: CollectionTag; id: LONGINT; whichAttributes: LONGINT; newAttributes: LONGINT): Types.OSErr;
  209.     (*$IF NOT GENERATINGCFM*)
  210.     INLINE PASCAL $700B, $ABF6;
  211.     (*$END*)
  212. PROCEDURE GetCollectionItemInfo*(c: Collection; tag: CollectionTag; id: LONGINT; VAR index: LONGINT; VAR itemSize: LONGINT; VAR attributes: LONGINT): Types.OSErr;
  213.     (*$IF NOT GENERATINGCFM*)
  214.     INLINE PASCAL $700C, $ABF6;
  215.     (*$END*)
  216. PROCEDURE ReplaceIndexedCollectionItem*(c: Collection; index: LONGINT; itemSize: LONGINT; itemData: (*ΔΔUNIVΔΔ*) Types.Ptr): Types.OSErr;
  217.     (*$IF NOT GENERATINGCFM*)
  218.     INLINE PASCAL $700D, $ABF6;
  219.     (*$END*)
  220. PROCEDURE GetIndexedCollectionItem*(c: Collection; index: LONGINT; VAR itemSize: LONGINT; itemData: (*ΔΔUNIVΔΔ*) Types.Ptr): Types.OSErr;
  221.     (*$IF NOT GENERATINGCFM*)
  222.     INLINE PASCAL $700E, $ABF6;
  223.     (*$END*)
  224. PROCEDURE RemoveIndexedCollectionItem*(c: Collection; index: LONGINT): Types.OSErr;
  225.     (*$IF NOT GENERATINGCFM*)
  226.     INLINE PASCAL $700F, $ABF6;
  227.     (*$END*)
  228. PROCEDURE SetIndexedCollectionItemInfo*(c: Collection; index: LONGINT; whichAttributes: LONGINT; newAttributes: LONGINT): Types.OSErr;
  229.     (*$IF NOT GENERATINGCFM*)
  230.     INLINE PASCAL $7010, $ABF6;
  231.     (*$END*)
  232. PROCEDURE GetIndexedCollectionItemInfo*(c: Collection; index: LONGINT; VAR tag: CollectionTag; VAR id: LONGINT; VAR itemSize: LONGINT; VAR attributes: LONGINT): Types.OSErr;
  233.     (*$IF NOT GENERATINGCFM*)
  234.     INLINE PASCAL $7011, $ABF6;
  235.     (*$END*)
  236. PROCEDURE CollectionTagExists*(c: Collection; tag: CollectionTag): BOOLEAN;
  237.     (*$IF NOT GENERATINGCFM*)
  238.     INLINE PASCAL $7012, $ABF6;
  239.     (*$END*)
  240. PROCEDURE CountCollectionTags*(c: Collection): LONGINT;
  241.     (*$IF NOT GENERATINGCFM*)
  242.     INLINE PASCAL $7013, $ABF6;
  243.     (*$END*)
  244. PROCEDURE GetIndexedCollectionTag*(c: Collection; tagIndex: LONGINT; VAR tag: CollectionTag): Types.OSErr;
  245.     (*$IF NOT GENERATINGCFM*)
  246.     INLINE PASCAL $7014, $ABF6;
  247.     (*$END*)
  248. PROCEDURE CountTaggedCollectionItems*(c: Collection; tag: CollectionTag): LONGINT;
  249.     (*$IF NOT GENERATINGCFM*)
  250.     INLINE PASCAL $7015, $ABF6;
  251.     (*$END*)
  252. PROCEDURE GetTaggedCollectionItem*(c: Collection; tag: CollectionTag; whichItem: LONGINT; VAR itemSize: LONGINT; itemData: (*ΔΔUNIVΔΔ*) Types.Ptr): Types.OSErr;
  253.     (*$IF NOT GENERATINGCFM*)
  254.     INLINE PASCAL $7016, $ABF6;
  255.     (*$END*)
  256. PROCEDURE GetTaggedCollectionItemInfo*(c: Collection; tag: CollectionTag; whichItem: LONGINT; VAR id: LONGINT; VAR index: LONGINT; VAR itemSize: LONGINT; VAR attributes: LONGINT): Types.OSErr;
  257.     (*$IF NOT GENERATINGCFM*)
  258.     INLINE PASCAL $7017, $ABF6;
  259.     (*$END*)
  260. PROCEDURE PurgeCollection*(c: Collection; whichAttributes: LONGINT; matchingAttributes: LONGINT);
  261.     (*$IF NOT GENERATINGCFM*)
  262.     INLINE PASCAL $7018, $ABF6;
  263.     (*$END*)
  264. PROCEDURE PurgeCollectionTag*(c: Collection; tag: CollectionTag);
  265.     (*$IF NOT GENERATINGCFM*)
  266.     INLINE PASCAL $7019, $ABF6;
  267.     (*$END*)
  268. PROCEDURE EmptyCollection*(c: Collection);
  269.     (*$IF NOT GENERATINGCFM*)
  270.     INLINE PASCAL $701A, $ABF6;
  271.     (*$END*)
  272. PROCEDURE FlattenCollection*(c: Collection; flattenProc: CollectionFlattenUPP; refCon: (*ΔΔUNIVΔΔ*) Types.Ptr): Types.OSErr;
  273.     (*$IF NOT GENERATINGCFM*)
  274.     INLINE PASCAL $701B, $ABF6;
  275.     (*$END*)
  276. PROCEDURE FlattenPartialCollection*(c: Collection; flattenProc: CollectionFlattenUPP; refCon: (*ΔΔUNIVΔΔ*) Types.Ptr; whichAttributes: LONGINT; matchingAttributes: LONGINT): Types.OSErr;
  277.     (*$IF NOT GENERATINGCFM*)
  278.     INLINE PASCAL $701C, $ABF6;
  279.     (*$END*)
  280. PROCEDURE UnflattenCollection*(c: Collection; flattenProc: CollectionFlattenUPP; refCon: (*ΔΔUNIVΔΔ*) Types.Ptr): Types.OSErr;
  281.     (*$IF NOT GENERATINGCFM*)
  282.     INLINE PASCAL $701D, $ABF6;
  283.     (*$END*)
  284. PROCEDURE GetCollectionExceptionProc*(c: Collection): CollectionExceptionUPP;
  285.     (*$IF NOT GENERATINGCFM*)
  286.     INLINE PASCAL $701E, $ABF6;
  287.     (*$END*)
  288. PROCEDURE SetCollectionExceptionProc*(c: Collection; exceptionProc: CollectionExceptionUPP);
  289.     (*$IF NOT GENERATINGCFM*)
  290.     INLINE PASCAL $701F, $ABF6;
  291.     (*$END*)
  292. (*****************************************************************************************)
  293. (* Utility Routines for handle-based access...                                                          *)
  294. (*****************************************************************************************)
  295. PROCEDURE GetNewCollection*(collectionID: INTEGER): Collection;
  296.     (*$IF NOT GENERATINGCFM*)
  297.     INLINE PASCAL $7020, $ABF6;
  298.     (*$END*)
  299. PROCEDURE AddCollectionItemHdl*(aCollection: Collection; tag: CollectionTag; id: LONGINT; itemData: Types.Handle): Types.OSErr;
  300.     (*$IF NOT GENERATINGCFM*)
  301.     INLINE PASCAL $7021, $ABF6;
  302.     (*$END*)
  303. PROCEDURE GetCollectionItemHdl*(aCollection: Collection; tag: CollectionTag; id: LONGINT; itemData: Types.Handle): Types.OSErr;
  304.     (*$IF NOT GENERATINGCFM*)
  305.     INLINE PASCAL $7022, $ABF6;
  306.     (*$END*)
  307. PROCEDURE ReplaceIndexedCollectionItemHdl*(aCollection: Collection; index: LONGINT; itemData: Types.Handle): Types.OSErr;
  308.     (*$IF NOT GENERATINGCFM*)
  309.     INLINE PASCAL $7023, $ABF6;
  310.     (*$END*)
  311. PROCEDURE GetIndexedCollectionItemHdl*(aCollection: Collection; index: LONGINT; itemData: Types.Handle): Types.OSErr;
  312.     (*$IF NOT GENERATINGCFM*)
  313.     INLINE PASCAL $7024, $ABF6;
  314.     (*$END*)
  315. PROCEDURE FlattenCollectionToHdl*(aCollection: Collection; flattened: Types.Handle): Types.OSErr;
  316.     (*$IF NOT GENERATINGCFM*)
  317.     INLINE PASCAL $7025, $ABF6;
  318.     (*$END*)
  319. PROCEDURE UnflattenCollectionFromHdl*(aCollection: Collection; flattened: Types.Handle): Types.OSErr;
  320.     (*$IF NOT GENERATINGCFM*)
  321.     INLINE PASCAL $7026, $ABF6;
  322.     (*$END*)
  323.  
  324. (* $ALIGN RESET*)
  325. (* $POP*)
  326.  
  327.  END Collections.
  328.